docs: Refactor pycodestyle/Flake8 compatibility docs #4194
Conversation
JelleZijlstra
left a comment
JelleZijlstra
left a comment
There was a problem hiding this comment.
Thanks, this is good, but I think there's some larger areas of possible improvement. If you're up for it, please make these changes; otherwise we can merge this as is and leave the rest for another PR.
cobaltt7
changed the title
Signed-off-by: RedGuy12 <[email protected]>
Signed-off-by: RedGuy12 <[email protected]>
There was a problem hiding this comment.
@JelleZijlstra I've made the requested changes. My thought process for some of the changes:
- I updated the
compatible_configsfolder (and added some for pycodestyle). This was an oversight in #3888. Not sure how useful this folder is, but I didn't think removing it would be in scope here. - It turns out that
E704is already disabled by default, so #3888 actually didn't document it correctly. Fixed that here. - I moved the pycodestyle section above Flake8 and moved the reasoning section there as well. Since Flake8 is a wrapper around pycodestyle, I felt like it made more sense to have the bulk of the docs in the pycodestyle section instead of under Flake8.
- The Bugbear information was previously only in current_style.md. I moved it to using_black_with_other_tools.md, and added a link in current_style.md and in the FAQ.
hauntsaninja
left a comment
hauntsaninja
left a comment
There was a problem hiding this comment.
Thanks for working on this!
hauntsaninja
added
the
skip news
Co-authored-by: Shantanu <[email protected]>
for more information, see https://pre-commit.ci
Signed-off-by: RedGuy12 <[email protected]>
JelleZijlstra
left a comment
JelleZijlstra
left a comment
There was a problem hiding this comment.
Thanks! A few more comments.
Co-authored-by: Jelle Zijlstra <[email protected]> Signed-off-by: RedGuy12 <[email protected]>
Signed-off-by: RedGuy12 <[email protected]>
| @@ -0,0 +1,3 @@ | |||
| [pycodestyle] | |||
| max-line-length = 88 | |||
| ignore = E203,E701 | |||
There was a problem hiding this comment.
pycodestyle does not read the .flake8 config file
this configuration also will result in quite a lot of frustration as it enables several pairs of incompatible codes
There was a problem hiding this comment.
whoops, that looks it was my bad; the black docs do have the correct formats listed
what further incompatible codes need to be disabled?
There was a problem hiding this comment.
personally I would include (at least) all of the disabled-by-default codes
4 participants
Description
Resolves #4173
Related to #3888
Checklist - did you ...
CHANGES.mdif necessary?